<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />
	<meta name="robots" content="noindex" />

	<title>File Mandrill/Senders.php</title>

	<script type="text/javascript" src="resources/combined.js?394153670"></script>
	<script type="text/javascript" src="elementlist.js?882160656"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Namespaces</h3>
			<ul>
				<li class="active"><a href="namespace-None.html">None</a>
						</li>
				<li><a href="namespace-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Mandrill.html">Mandrill</a></li>
				<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
				<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
				<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
				<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
				<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
				<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
				<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
				<li class="active"><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
				<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
				<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
				<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
				<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
				<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
				<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
				<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
			</ul>



			<h3>Exceptions</h3>
			<ul>
				<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
				<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
				<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
				<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
				<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
				<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
				<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
				<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
				<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
				<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
				<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
				<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
				<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
				<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
				<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
				<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
				<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
				<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
				<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
				<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
				<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
				<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
				<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
				<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
				<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
				<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
				<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
				<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
				<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
				<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
				<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
			</li>
			<li>
				<a href="class-Mandrill_Senders.html" title="Summary of Mandrill_Senders"><span>Class</span></a>
			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<pre><code><span id="1" class="l"><a class="l" href="#1">  1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2">  2: </a>
</span><span id="3" class="l"><a class="l" href="#3">  3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Senders" href="#Mandrill_Senders">Mandrill_Senders</a> {
</span><span id="4" class="l"><a class="l" href="#4">  4: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(Mandrill <span class="php-var">$master</span>) {
</span><span id="5" class="l"><a class="l" href="#5">  5: </a>        <span class="php-var">$this</span>-&gt;master = <span class="php-var">$master</span>;
</span><span id="6" class="l"><a class="l" href="#6">  6: </a>    }
</span><span id="7" class="l"><a class="l" href="#7">  7: </a>
</span><span id="8" class="l"><a class="l" href="#8">  8: </a>    <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9">  9: </a><span class="php-comment">     * Return the senders that have tried to use this account.
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment">     * @return array an array of sender data, one for each sending addresses used by the account
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">     *     - return[] struct the information on each sending address in the account
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">     *         - address string the sender's email address
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">     *         - created_at string the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment">     *         - sent integer the total number of messages sent by this sender
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment">     *         - hard_bounces integer the total number of hard bounces by messages by this sender
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">     *         - soft_bounces integer the total number of soft bounces by messages by this sender
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment">     *         - rejects integer the total number of rejected messages by this sender
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment">     *         - complaints integer the total number of spam complaints received for messages by this sender
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment">     *         - unsubs integer the total number of unsubscribe requests received for messages by this sender
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment">     *         - opens integer the total number of times messages by this sender have been opened
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">     *         - clicks integer the total number of times tracked URLs in messages by this sender have been clicked
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment">     *         - unique_opens integer the number of unique opens for emails sent for this sender
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment">     *         - unique_clicks integer the number of unique clicks for emails sent for this sender
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment">     */</span>
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>() {
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/list'</span>, <span class="php-var">$_params</span>);
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a>    }
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a>
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>    <span class="php-comment">/**
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">     * Returns the sender domains that have been added to this account.
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment">     * @return array an array of sender domain data, one for each sending domain used by the account
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment">     *     - return[] struct the information on each sending domain for the account
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment">     *         - domain string the sender domain name
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment">     *         - created_at string the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">     *         - last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment">     *         - spf struct details about the domain's SPF record
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment">     *             - valid boolean whether the domain's SPF record is valid for use with Mandrill
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment">     *             - valid_after string when the domain's SPF record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment">     *             - error string an error describing the spf record, or null if the record is correct
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">     *         - dkim struct details about the domain's DKIM record
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment">     *             - valid boolean whether the domain's DKIM record is valid for use with Mandrill
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment">     *             - valid_after string when the domain's DKIM record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment">     *             - error string an error describing the DKIM record, or null if the record is correct
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment">     *         - verified_at string if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">     *         - valid_signing boolean whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment">     */</span>
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_domains" href="#_domains">domains</a>() {
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/domains'</span>, <span class="php-var">$_params</span>);
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a>    }
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a>
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a>    <span class="php-comment">/**
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment">     * Adds a sender domain to your account. Sender domains are added automatically as you
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment">send, but you can use this call to add them ahead of time.
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">     * @param string $domain a domain name
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment">     * @return struct information about the domain
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment">     *     - domain string the sender domain name
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment">     *     - created_at string the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment">     *     - last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">     *     - spf struct details about the domain's SPF record
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment">     *         - valid boolean whether the domain's SPF record is valid for use with Mandrill
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment">     *         - valid_after string when the domain's SPF record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment">     *         - error string an error describing the spf record, or null if the record is correct
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment">     *     - dkim struct details about the domain's DKIM record
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">     *         - valid boolean whether the domain's DKIM record is valid for use with Mandrill
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment">     *         - valid_after string when the domain's DKIM record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment">     *         - error string an error describing the DKIM record, or null if the record is correct
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment">     *     - verified_at string if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment">     *     - valid_signing boolean whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">     */</span>
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addDomain" href="#_addDomain">addDomain</a>(<span class="php-var">$domain</span>) {
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/add-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>    }
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a>
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a>    <span class="php-comment">/**
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment">     * Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment">account, it will be added automatically.
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment">     * @param string $domain a domain name
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">     * @return struct information about the sender domain
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment">     *     - domain string the sender domain name
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment">     *     - created_at string the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment">     *     - last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment">     *     - spf struct details about the domain's SPF record
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">     *         - valid boolean whether the domain's SPF record is valid for use with Mandrill
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment">     *         - valid_after string when the domain's SPF record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment">     *         - error string an error describing the spf record, or null if the record is correct
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment">     *     - dkim struct details about the domain's DKIM record
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment">     *         - valid boolean whether the domain's DKIM record is valid for use with Mandrill
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">     *         - valid_after string when the domain's DKIM record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment">     *         - error string an error describing the DKIM record, or null if the record is correct
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment">     *     - verified_at string if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment">     *     - valid_signing boolean whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment">     */</span>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_checkDomain" href="#_checkDomain">checkDomain</a>(<span class="php-var">$domain</span>) {
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/check-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a>    }
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a>    <span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment">     * Sends a verification email in order to verify ownership of a domain.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment">Domain verification is an optional step to confirm ownership of a domain. Once a
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment">domain has been verified in a Mandrill account, other accounts may not have their
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment">messages signed by that domain unless they also verify the domain. This prevents
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">other Mandrill accounts from sending mail signed by your domain.
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment">     * @param string $domain a domain name at which you can receive email
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment">     * @param string $mailbox a mailbox at the domain where the verification email should be sent
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment">     * @return struct information about the verification that was sent
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment">     *     - status string &quot;sent&quot; indicates that the verification has been sent, &quot;already_verified&quot; indicates that the domain has already been verified with your account
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">     *     - domain string the domain name you provided
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment">     *     - email string the email address the verification email was sent to
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment">     */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_verifyDomain" href="#_verifyDomain">verifyDomain</a>(<span class="php-var">$domain</span>, <span class="php-var">$mailbox</span>) {
</span><span id="115" class="l"><a class="l" href="#115">115: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>, <span class="php-quote">&quot;mailbox&quot;</span> =&gt; <span class="php-var">$mailbox</span>);
</span><span id="116" class="l"><a class="l" href="#116">116: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/verify-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="117" class="l"><a class="l" href="#117">117: </a>    }
</span><span id="118" class="l"><a class="l" href="#118">118: </a>
</span><span id="119" class="l"><a class="l" href="#119">119: </a>    <span class="php-comment">/**
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment">     * Return more detailed information about a single sender, including aggregates of recent stats
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">     * @param string $address the email address of the sender
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment">     * @return struct the detailed information on the sender
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment">     *     - address string the sender's email address
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment">     *     - created_at string the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment">     *     - sent integer the total number of messages sent by this sender
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">     *     - hard_bounces integer the total number of hard bounces by messages by this sender
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment">     *     - soft_bounces integer the total number of soft bounces by messages by this sender
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment">     *     - rejects integer the total number of rejected messages by this sender
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment">     *     - complaints integer the total number of spam complaints received for messages by this sender
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment">     *     - unsubs integer the total number of unsubscribe requests received for messages by this sender
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">     *     - opens integer the total number of times messages by this sender have been opened
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment">     *     - clicks integer the total number of times tracked URLs in messages by this sender have been clicked
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment">     *     - stats struct an aggregate summary of the sender's sending stats
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment">     *         - today struct stats for this sender so far today
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment">     *             - sent integer the number of emails sent for this sender so far today
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">     *             - hard_bounces integer the number of emails hard bounced for this sender so far today
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment">     *             - soft_bounces integer the number of emails soft bounced for this sender so far today
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment">     *             - rejects integer the number of emails rejected for sending this sender so far today
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment">     *             - complaints integer the number of spam complaints for this sender so far today
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment">     *             - unsubs integer the number of unsubscribes for this sender so far today
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">     *             - opens integer the number of times emails have been opened for this sender so far today
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment">     *             - unique_opens integer the number of unique opens for emails sent for this sender so far today
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment">     *             - clicks integer the number of URLs that have been clicked for this sender so far today
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment">     *             - unique_clicks integer the number of unique clicks for emails sent for this sender so far today
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment">     *         - last_7_days struct stats for this sender in the last 7 days
</span></span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">     *             - sent integer the number of emails sent for this sender in the last 7 days
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment">     *             - hard_bounces integer the number of emails hard bounced for this sender in the last 7 days
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment">     *             - soft_bounces integer the number of emails soft bounced for this sender in the last 7 days
</span></span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-comment">     *             - rejects integer the number of emails rejected for sending this sender in the last 7 days
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment">     *             - complaints integer the number of spam complaints for this sender in the last 7 days
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment">     *             - unsubs integer the number of unsubscribes for this sender in the last 7 days
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment">     *             - opens integer the number of times emails have been opened for this sender in the last 7 days
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment">     *             - unique_opens integer the number of unique opens for emails sent for this sender in the last 7 days
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment">     *             - clicks integer the number of URLs that have been clicked for this sender in the last 7 days
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment">     *             - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 7 days
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment">     *         - last_30_days struct stats for this sender in the last 30 days
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment">     *             - sent integer the number of emails sent for this sender in the last 30 days
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment">     *             - hard_bounces integer the number of emails hard bounced for this sender in the last 30 days
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment">     *             - soft_bounces integer the number of emails soft bounced for this sender in the last 30 days
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment">     *             - rejects integer the number of emails rejected for sending this sender in the last 30 days
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment">     *             - complaints integer the number of spam complaints for this sender in the last 30 days
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment">     *             - unsubs integer the number of unsubscribes for this sender in the last 30 days
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment">     *             - opens integer the number of times emails have been opened for this sender in the last 30 days
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment">     *             - unique_opens integer the number of unique opens for emails sent for this sender in the last 30 days
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment">     *             - clicks integer the number of URLs that have been clicked for this sender in the last 30 days
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment">     *             - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 30 days
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment">     *         - last_60_days struct stats for this sender in the last 60 days
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment">     *             - sent integer the number of emails sent for this sender in the last 60 days
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment">     *             - hard_bounces integer the number of emails hard bounced for this sender in the last 60 days
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment">     *             - soft_bounces integer the number of emails soft bounced for this sender in the last 60 days
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment">     *             - rejects integer the number of emails rejected for sending this sender in the last 60 days
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment">     *             - complaints integer the number of spam complaints for this sender in the last 60 days
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment">     *             - unsubs integer the number of unsubscribes for this sender in the last 60 days
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment">     *             - opens integer the number of times emails have been opened for this sender in the last 60 days
</span></span><span id="175" class="l"><a class="l" href="#175">175: </a><span class="php-comment">     *             - unique_opens integer the number of unique opens for emails sent for this sender in the last 60 days
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment">     *             - clicks integer the number of URLs that have been clicked for this sender in the last 60 days
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment">     *             - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 60 days
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment">     *         - last_90_days struct stats for this sender in the last 90 days
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment">     *             - sent integer the number of emails sent for this sender in the last 90 days
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment">     *             - hard_bounces integer the number of emails hard bounced for this sender in the last 90 days
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment">     *             - soft_bounces integer the number of emails soft bounced for this sender in the last 90 days
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment">     *             - rejects integer the number of emails rejected for sending this sender in the last 90 days
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment">     *             - complaints integer the number of spam complaints for this sender in the last 90 days
</span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment">     *             - unsubs integer the number of unsubscribes for this sender in the last 90 days
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment">     *             - opens integer the number of times emails have been opened for this sender in the last 90 days
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment">     *             - unique_opens integer the number of unique opens for emails sent for this sender in the last 90 days
</span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment">     *             - clicks integer the number of URLs that have been clicked for this sender in the last 90 days
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment">     *             - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 90 days
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment">     */</span>
</span><span id="190" class="l"><a class="l" href="#190">190: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$address</span>) {
</span><span id="191" class="l"><a class="l" href="#191">191: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;address&quot;</span> =&gt; <span class="php-var">$address</span>);
</span><span id="192" class="l"><a class="l" href="#192">192: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/info'</span>, <span class="php-var">$_params</span>);
</span><span id="193" class="l"><a class="l" href="#193">193: </a>    }
</span><span id="194" class="l"><a class="l" href="#194">194: </a>
</span><span id="195" class="l"><a class="l" href="#195">195: </a>    <span class="php-comment">/**
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment">     * Return the recent history (hourly stats for the last 30 days) for a sender
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment">     * @param string $address the email address of the sender
</span></span><span id="198" class="l"><a class="l" href="#198">198: </a><span class="php-comment">     * @return array the array of history information
</span></span><span id="199" class="l"><a class="l" href="#199">199: </a><span class="php-comment">     *     - return[] struct the stats for a single hour
</span></span><span id="200" class="l"><a class="l" href="#200">200: </a><span class="php-comment">     *         - time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="201" class="l"><a class="l" href="#201">201: </a><span class="php-comment">     *         - sent integer the number of emails that were sent during the hour
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment">     *         - hard_bounces integer the number of emails that hard bounced during the hour
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment">     *         - soft_bounces integer the number of emails that soft bounced during the hour
</span></span><span id="204" class="l"><a class="l" href="#204">204: </a><span class="php-comment">     *         - rejects integer the number of emails that were rejected during the hour
</span></span><span id="205" class="l"><a class="l" href="#205">205: </a><span class="php-comment">     *         - complaints integer the number of spam complaints received during the hour
</span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment">     *         - opens integer the number of emails opened during the hour
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment">     *         - unique_opens integer the number of unique opens generated by messages sent during the hour
</span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment">     *         - clicks integer the number of tracked URLs clicked during the hour
</span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment">     *         - unique_clicks integer the number of unique clicks generated by messages sent during the hour
</span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment">     */</span>
</span><span id="211" class="l"><a class="l" href="#211">211: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_timeSeries" href="#_timeSeries">timeSeries</a>(<span class="php-var">$address</span>) {
</span><span id="212" class="l"><a class="l" href="#212">212: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;address&quot;</span> =&gt; <span class="php-var">$address</span>);
</span><span id="213" class="l"><a class="l" href="#213">213: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/time-series'</span>, <span class="php-var">$_params</span>);
</span><span id="214" class="l"><a class="l" href="#214">214: </a>    }
</span><span id="215" class="l"><a class="l" href="#215">215: </a>
</span><span id="216" class="l"><a class="l" href="#216">216: </a>}
</span><span id="217" class="l"><a class="l" href="#217">217: </a>
</span><span id="218" class="l"><a class="l" href="#218">218: </a>
</span><span id="219" class="l"><a class="l" href="#219">219: </a></span></code></pre>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
